com.highdeal.hci
Class DescriptionModel

java.lang.Object
  com.highdeal.hci.HCIModelAdapter
      com.highdeal.hci.DescriptionModel

All Implemented Interfaces:

ITagNameProvider, IXMLMarshallable, XMLMarshallable

public class DescriptionModel
extends HCIModelAdapter

This class is a description container.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:simpleType name="DescriptionType">
   <xs:restriction base="xs:string" />
  </xs:simpleType>

Field Summary

static java.lang.String

TAG_NAME The value of that constant is the XML tag name of the Description.

Constructor Summary

DescriptionModel()
Constructs a DescriptionModel with a null description

DescriptionModel(java.lang.String description)
Constructs a DescriptionModel with a given String description

Method Summary

void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
java.lang.String	getDescription() Gets the String text of the description
static java.lang.String	getDescriptionFromModel(DescriptionModel model) Gets the String description coming from a DescriptionModel.
java.lang.String	getTagName() Gets the XML tag name of the HCI model.
void	marshalAttributes(XMLOutputter output) Gives an XML representation of the attributes of an object.
void	marshalChildren(XMLOutputter output) Gives an XML representation of the child objects of an object.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setDescription(java.lang.String description) Sets the String description
static DescriptionModel	setDescriptionIntoModel(DescriptionModel model, java.lang.String description) Sets a String description text into a DescriptionModel object

Methods inherited from class com.highdeal.hci.HCIModelAdapter

marshal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAG_NAME

public static final java.lang.String TAG_NAME

The value of that constant is the XML tag name of the Description.

See Also:

Constant Field Values

Constructor Detail

DescriptionModel

public DescriptionModel()

Constructs a DescriptionModel with a null description

DescriptionModel

public DescriptionModel(java.lang.String description)

Constructs a DescriptionModel with a given String description

Parameters:

description - The String description of the DescriptionModel

Method Detail

getDescription

public java.lang.String getDescription()

Gets the String text of the description

Returns:

The String description

setDescription

public void setDescription(java.lang.String description)

Sets the String description

Parameters:

description - the String description

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Parameters:

cData - The character data to be added

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Parameters:

tagName - The name of tag for the child

child - The child to be added

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Parameters:

atts - The XML attributes of the current element

marshalAttributes

public void marshalAttributes(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the attributes of an object.

Parameters:

output - The XML output to marshal the object attributes into

marshalChildren

public void marshalChildren(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the child objects of an object.

Parameters:

output - The XML output to marshal the child objects into

getTagName

public java.lang.String getTagName()

Description copied from interface: ITagNameProvider

Gets the XML tag name of the HCI model.

Returns:

The XML tag name

getDescriptionFromModel

public static final java.lang.String getDescriptionFromModel(DescriptionModel model)

Gets the String description coming from a DescriptionModel.

Parameters:

model - The DescriptionModel which we want to exact the String description

Returns:

The String description text coming from the DescriptionModel and returns null if the model is null

setDescriptionIntoModel

public static final DescriptionModel setDescriptionIntoModel(DescriptionModel model,
                                                             java.lang.String description)

Sets a String description text into a DescriptionModel object

Parameters:

model - DescriptionModel which you want to set the String description

description - The String description to be set into the DescriptionModel

Returns:

a DescriptionModel including the String description Returns a new DescriptionModel if the DescriptionModel given in parameter is null. Returns null if the String description null